Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EDU-3601: Small change for TF User best practices docs. #3219

Merged
merged 2 commits into from
Nov 22, 2024

Conversation

jlacefie
Copy link
Contributor

This change adds guidance to mitigate overwriting a user's Temporal permissions as discussed in the TF issue temporalio/terraform-provider-temporalcloud#119

The change is very small and localized to one Note block. This doc update accompanies a doc update in the Hashi Registry documentation.

@jlacefie jlacefie requested a review from a team as a code owner November 22, 2024 21:52
@fairlydurable fairlydurable changed the title Small change for TF User best practices docs. EDU-3601: Small change for TF User best practices docs. Nov 22, 2024
Copy link
Contributor

@fairlydurable fairlydurable left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broke the bullet point into individual sentence lines.

Otherwise looks good to me.

This is why we put items on separate lines, nominally sentences:

  • Improves version control diffs for easier line-by-line inspection.
  • Focuses feedback and review discussions on single points, preventing overlap with other content that may need changes.
  • Reduces overlap and merge conflicts with other tickets.
  • Enhances the precision of our automated lint tooling, such as Vale (vale /path/to/file.mdx), allowing you to more easily locate and address issues by line number.

@fairlydurable fairlydurable merged commit d228c66 into main Nov 22, 2024
3 checks passed
@fairlydurable fairlydurable deleted the jlacefie/tfdoc branch November 22, 2024 22:04
stephanos pushed a commit to stephanos/documentation that referenced this pull request Dec 9, 2024
)

* Small change for TF User best practices docs.

* Update docs/production-deployment/cloud/terraform-provider.mdx

---------

Co-authored-by: Erica Sadun <156466156+fairlydurable@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants